<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PinCRT: Readers writers lock</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">PinCRT
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Readers writers lock</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga3bc96921c120dafc2ce6da960c87caf6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OS__APIS__RW__LOCK.html#ga3bc96921c120dafc2ce6da960c87caf6">OS_RWLockInitialize</a> (volatile OS_APIS_RW_LOCK_T *l)</td></tr>
<tr class="separator:ga3bc96921c120dafc2ce6da960c87caf6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga923da6354d93bb4e0dd8d5bb6de3ba61"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OS__APIS__RW__LOCK.html#ga923da6354d93bb4e0dd8d5bb6de3ba61">OS_RWLockDestroy</a> (volatile OS_APIS_RW_LOCK_T *l)</td></tr>
<tr class="separator:ga923da6354d93bb4e0dd8d5bb6de3ba61"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4d1e017034dd744a890fdc41dc4fc4ba"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OS__APIS__RW__LOCK.html#ga4d1e017034dd744a890fdc41dc4fc4ba">OS_RWLockAcquireWrite</a> (volatile OS_APIS_RW_LOCK_T *lock)</td></tr>
<tr class="separator:ga4d1e017034dd744a890fdc41dc4fc4ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3526da4bff453fbbbc6127efc822c52d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OS__APIS__RW__LOCK.html#ga3526da4bff453fbbbc6127efc822c52d">OS_RWLockReleaseWrite</a> (volatile OS_APIS_RW_LOCK_T *lock)</td></tr>
<tr class="separator:ga3526da4bff453fbbbc6127efc822c52d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8918bcd26d70ff27ef88361714db80e2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OS__APIS__RW__LOCK.html#ga8918bcd26d70ff27ef88361714db80e2">OS_RWLockAcquireRead</a> (volatile OS_APIS_RW_LOCK_T *lock)</td></tr>
<tr class="separator:ga8918bcd26d70ff27ef88361714db80e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab7d5fc7eab89461cdd378727d6ca4e26"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OS__APIS__RW__LOCK.html#gab7d5fc7eab89461cdd378727d6ca4e26">OS_RWLockReleaseRead</a> (volatile OS_APIS_RW_LOCK_T *lock)</td></tr>
<tr class="separator:gab7d5fc7eab89461cdd378727d6ca4e26"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga52f5e476c184ba6a7e19e9e19865423f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__OS__APIS__TYPES.html#gad312c486942310e24394e7ea81f8f7e1">BOOL_T</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OS__APIS__RW__LOCK.html#ga52f5e476c184ba6a7e19e9e19865423f">OS_RWLockRelease</a> (volatile OS_APIS_RW_LOCK_T *l)</td></tr>
<tr class="separator:ga52f5e476c184ba6a7e19e9e19865423f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga283bb2cfbc87c890ef694c7412cd370b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__OS__APIS__TYPES.html#gad312c486942310e24394e7ea81f8f7e1">BOOL_T</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OS__APIS__RW__LOCK.html#ga283bb2cfbc87c890ef694c7412cd370b">OS_RWLockTryAcquireWrite</a> (volatile OS_APIS_RW_LOCK_T *l)</td></tr>
<tr class="separator:ga283bb2cfbc87c890ef694c7412cd370b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8cb8d435497794feef67f36a6d40841d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__OS__APIS__TYPES.html#gad312c486942310e24394e7ea81f8f7e1">BOOL_T</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OS__APIS__RW__LOCK.html#ga8cb8d435497794feef67f36a6d40841d">OS_RWLockTryAcquireRead</a> (volatile OS_APIS_RW_LOCK_T *l)</td></tr>
<tr class="separator:ga8cb8d435497794feef67f36a6d40841d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga8918bcd26d70ff27ef88361714db80e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8918bcd26d70ff27ef88361714db80e2">&#9670;&nbsp;</a></span>OS_RWLockAcquireRead()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void OS_RWLockAcquireRead </td>
          <td>(</td>
          <td class="paramtype">volatile OS_APIS_RW_LOCK_T *&#160;</td>
          <td class="paramname"><em>lock</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Acquires the lock for reader. Blocks until the reader lock is acquired.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">lock</td><td>The lock to acquire</td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Availability:</dt><dd><b>O/S</b>: Windows, Linux &amp; macOS*<br  />
 <b>CPU:</b> All<br  />
</dd></dl>

</div>
</div>
<a id="ga4d1e017034dd744a890fdc41dc4fc4ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4d1e017034dd744a890fdc41dc4fc4ba">&#9670;&nbsp;</a></span>OS_RWLockAcquireWrite()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void OS_RWLockAcquireWrite </td>
          <td>(</td>
          <td class="paramtype">volatile OS_APIS_RW_LOCK_T *&#160;</td>
          <td class="paramname"><em>lock</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Acquires the lock for writer. Blocks until the writer lock is acquired.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">lock</td><td>The lock to acquire</td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Availability:</dt><dd><b>O/S</b>: Windows, Linux &amp; macOS*<br  />
 <b>CPU:</b> All<br  />
</dd></dl>

</div>
</div>
<a id="ga923da6354d93bb4e0dd8d5bb6de3ba61"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga923da6354d93bb4e0dd8d5bb6de3ba61">&#9670;&nbsp;</a></span>OS_RWLockDestroy()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void OS_RWLockDestroy </td>
          <td>(</td>
          <td class="paramtype">volatile OS_APIS_RW_LOCK_T *&#160;</td>
          <td class="paramname"><em>l</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Destroy a reader-writer lock, freeing all exhausted resources associated with the lock.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">lock</td><td>The lock to destroy</td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Availability:</dt><dd><b>O/S</b>: Windows, Linux &amp; macOS*<br  />
 <b>CPU:</b> All<br  />
</dd></dl>

</div>
</div>
<a id="ga3bc96921c120dafc2ce6da960c87caf6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3bc96921c120dafc2ce6da960c87caf6">&#9670;&nbsp;</a></span>OS_RWLockInitialize()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void OS_RWLockInitialize </td>
          <td>(</td>
          <td class="paramtype">volatile OS_APIS_RW_LOCK_T *&#160;</td>
          <td class="paramname"><em>l</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Initializes a reader-writer lock.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">lock</td><td>The lock to initialize</td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Availability:</dt><dd><b>O/S</b>: Windows, Linux &amp; macOS*<br  />
 <b>CPU:</b> All<br  />
</dd></dl>

</div>
</div>
<a id="ga52f5e476c184ba6a7e19e9e19865423f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga52f5e476c184ba6a7e19e9e19865423f">&#9670;&nbsp;</a></span>OS_RWLockRelease()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__OS__APIS__TYPES.html#gad312c486942310e24394e7ea81f8f7e1">BOOL_T</a> OS_RWLockRelease </td>
          <td>(</td>
          <td class="paramtype">volatile OS_APIS_RW_LOCK_T *&#160;</td>
          <td class="paramname"><em>l</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Releases the lock that was acquired. The lock kind that was acquired (whether its read or write) is determined by this function.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">lock</td><td>The lock to release</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>TRUE if the lock was taken (for either read or write) and as a result of this call is unlocked, FALSE otherwise. If the reader lock was released, and a waiting writer was woken up and acquired the lock, the function will return TRUE.</dd></dl>
<dl class="section user"><dt>Availability:</dt><dd><b>O/S</b>: Windows, Linux &amp; macOS*<br  />
 <b>CPU:</b> All<br  />
</dd></dl>

</div>
</div>
<a id="gab7d5fc7eab89461cdd378727d6ca4e26"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab7d5fc7eab89461cdd378727d6ca4e26">&#9670;&nbsp;</a></span>OS_RWLockReleaseRead()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void OS_RWLockReleaseRead </td>
          <td>(</td>
          <td class="paramtype">volatile OS_APIS_RW_LOCK_T *&#160;</td>
          <td class="paramname"><em>lock</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Releases the lock for reader.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">lock</td><td>The lock to release</td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Availability:</dt><dd><b>O/S</b>: Windows, Linux &amp; macOS*<br  />
 <b>CPU:</b> All<br  />
</dd></dl>

</div>
</div>
<a id="ga3526da4bff453fbbbc6127efc822c52d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3526da4bff453fbbbc6127efc822c52d">&#9670;&nbsp;</a></span>OS_RWLockReleaseWrite()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void OS_RWLockReleaseWrite </td>
          <td>(</td>
          <td class="paramtype">volatile OS_APIS_RW_LOCK_T *&#160;</td>
          <td class="paramname"><em>lock</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Releases the lock for writer.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">lock</td><td>The lock to release</td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Availability:</dt><dd><b>O/S</b>: Windows, Linux &amp; macOS*<br  />
 <b>CPU:</b> All<br  />
</dd></dl>

</div>
</div>
<a id="ga8cb8d435497794feef67f36a6d40841d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8cb8d435497794feef67f36a6d40841d">&#9670;&nbsp;</a></span>OS_RWLockTryAcquireRead()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__OS__APIS__TYPES.html#gad312c486942310e24394e7ea81f8f7e1">BOOL_T</a> OS_RWLockTryAcquireRead </td>
          <td>(</td>
          <td class="paramtype">volatile OS_APIS_RW_LOCK_T *&#160;</td>
          <td class="paramname"><em>l</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Tries to Acquire the lock for reader. This function returns immediately if the lock can't be acquired.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">lock</td><td>The lock to acquire</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>TRUE If the reader lock was acquired.</dd></dl>
<dl class="section user"><dt>Availability:</dt><dd><b>O/S</b>: Windows, Linux &amp; macOS*<br  />
 <b>CPU:</b> All<br  />
</dd></dl>

</div>
</div>
<a id="ga283bb2cfbc87c890ef694c7412cd370b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga283bb2cfbc87c890ef694c7412cd370b">&#9670;&nbsp;</a></span>OS_RWLockTryAcquireWrite()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__OS__APIS__TYPES.html#gad312c486942310e24394e7ea81f8f7e1">BOOL_T</a> OS_RWLockTryAcquireWrite </td>
          <td>(</td>
          <td class="paramtype">volatile OS_APIS_RW_LOCK_T *&#160;</td>
          <td class="paramname"><em>l</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Tries to Acquire the lock for writer. This function returns immediately if the lock can't be acquired.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">lock</td><td>The lock to acquire</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>TRUE If the writer lock was acquired.</dd></dl>
<dl class="section user"><dt>Availability:</dt><dd><b>O/S</b>: Windows, Linux &amp; macOS*<br  />
 <b>CPU:</b> All<br  />
</dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
